Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: support subcategories, reorganise Engineering Handbook #408

Merged
merged 2 commits into from
Apr 21, 2023

Conversation

kgpayne
Copy link
Contributor

@kgpayne kgpayne commented Apr 21, 2023

There doesn't seem to be a supported way to do subcategories in Jekyll, so I used a workaround using Front Matter subcategory values. Bulma (the CSS library we are using) only supports 2 levels of depth in menu classes, which limits how much subcategorisation we can ultimately do, but 2 is still way better than 1 😅

Did this as I hope Guilds will become a subcategory 👍

@netlify
Copy link

netlify bot commented Apr 21, 2023

Deploy Preview for meltano-handbook ready!

Name Link
🔨 Latest commit c51fdd5
🔍 Latest deploy log https://app.netlify.com/sites/meltano-handbook/deploys/64429e88140ce70008ab3e0d
😎 Deploy Preview https://deploy-preview-408--meltano-handbook.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Copy link
Member

@WillDaSilva WillDaSilva left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

image

Right now each subcategory has an index page shown underneath the category in the table of contents. This results in each category title being repeated. Would it be possible for the category item in the table of contents to be clickable, and have the index page, rather than listing the index page beneath it?

If this isn't a relatively simple change, I'd say don't bother with it.

@kgpayne
Copy link
Contributor Author

kgpayne commented Apr 21, 2023

cc @tayloramurphy as I believe this was something you wanted to be able to do.

@kgpayne
Copy link
Contributor Author

kgpayne commented Apr 21, 2023

@WillDaSilva

Right now each subcategory has an index page shown underneath the category in the table of contents. This results in each category title being repeated. Would it be possible for the category item in the table of contents to be clickable, and have the index page, rather than listing the index page beneath it?

If this isn't a relatively simple change, I'd say don't bother with it.

I think its possible, but it involves iterating all the matching subcategory items page-urls looking for one ending in /index 🤔 We'd then probably want to exclude that item from the list if one was found. Will have a stab, and give up if it isn't easy 👍

Longer-term, I think it'd be better to just move to a more flexible (and more familiar) static site generator, Sphinx.

@kgpayne
Copy link
Contributor Author

kgpayne commented Apr 21, 2023

@WillDaSilva it turned out to be easy 😅👍

@kgpayne kgpayne merged commit bd08a58 into main Apr 21, 2023
@kgpayne kgpayne deleted the kgpayne/subcategories branch April 21, 2023 14:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants